-
Notifications
You must be signed in to change notification settings - Fork 69
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add envars + packaging docs, and hierarchy changes in doc #611
Conversation
Can one of the admins verify this patch? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've checked just the language, not if it easy to understand. And I haven't checked the hierarchy changes.
b29929b
to
f9dc548
Compare
Guys, I would like to know your opinions on the restructuralisation plans here as well @oamg/developers |
@pirat89 I like the hierarchy change idea. But for the moment it is very high-level to judge completely as soe content is duplicated (e.g. How to create a Leapp actor for RHEL 7 to 8 upgrade) and it is not completely clear what will go where... |
I realized it's hard to add new content specific to the el7toel8 leapp repository. As well, with new and new content, it's getting harder and harder to find something in the menu as number of items is growing. For that purpose, here is proposed the new structure of documentation that tries to reduce top level menu into categories that should cover other content in future we would like to add. TODO: it's still PoC. Another changes are expected yet.
See the commit d37e2b4 for more info about the capability.
@bocekm Done. |
## Packaging - Bump required leapp-framework capability to 1.4 (oamg#642) ## Upgrade handling ### Fixes - Fix comparison of the newest installed and booted kernel (oamg#600) - Fix remediation command for ipa-server removal (oamg#617) - Fix crash due to missing network interfaces during upgrade phases (oamg#625) - Fix error with /boot/efi existing on non-EFI systems (oamg#627) - Fix false positive detection of issue in /etc/default/grub that led into GRUB prompt (oamg#587) - Fix syntax error in upgrade script (oamg#619) - Inhibit upgrade with mount options in fstab that break mounting on RHEL 8 (oamg#639) - Inhibit upgrade on s390x machines with /boot on a separate partition (oamg#641) - Inhibit upgrade if multiple kernel-debug pkgs are installed (oamg#599) - Remove the initial-setup package to avoid it asking for EULA acceptance during upgrade (oamg#626) - Remove the *leapp-resume* service after the *FirstBoot* phase to prevent kill of the leapp process on `systemctl daemon-reload` (oamg#611) ### Enhancements - Add upgrade support for SAP HANA (own upgrade path) (oamg#503) - Allow upgrade with SCA enabled manifest (oamg#615) - Add actors to migrate Quagga to FRR (oamg#467) - Add stable uniq Key id for every dialog (oamg#618) - Respect the *kernel-rt* package (oamg#600) ## Additional changes interesting for devels - Add a possibility to overwrite virtualenv name using `$VENVNAME` (oamg#613) - Update product certificates for RHEL 8.3 GA and 8.4 Beta/HTB (oamg#624) Related leapp release: https://github.com/oamg/leapp/releases/tag/v0.12.0
Let's split description into 3 parts.
Added additional new documentation about envars and our solution of dependencies between the leapp framework and leapp repositories.
Reorg the structure of docs. I found the original structure very unfortunate from the point of el7toel8 repository. When we want to document stuff that is related just for the one specific repository, it's hard to find the right place where to put it. We have currently two tutorials, which one of them is already overcrowded by mixture of stuff related to the repository and actors from my POV. I am keeping the current tutorials kind of untouched - possible move of some parts can be done in future if needed. I am now super-busy and do not want to go so deep with the changes. Just picking main changes now:
Infrastructure
entry. Where we document stuff related to dependencies/packaging, CI/CD related stuff, versioning... whatever from the point of the leapp. Maybe the name is not the best, but I think that this stuff should be really grouped more together instead of growing top level menustructrure of the source files for documentations - the number of doc files is growing and to find specific files in one directory... So I would like to put some files under subdirs as well. e.g. files realted to el7toel8 are in their subdir. The links are obviously changed in that case. I already did some research where I should change links in external documents and I feel ok to do that.
To see the current shape of docs:
and open
127.0.0.1:8000
in your browser.The original "structure"
(hidden additional sub-trees that are not affected now)
The structure proposed in this PR
(currently; there is more stuff to change yet, but rather waiting for discussion before I put my time into it)
Note: see that relevant tutorials have duplicit reference, to keep the tutorials list complete and have reference on them in specific subtree too.